/**
	Copyright (c) 2009 Ozazo Pvt Ltd, INDIA

	Permission is hereby granted, free of charge, to any person or organization 
	obtaining a copy of this software and associated  documentation  files (the 
	"Software"), to deal in the Software without restriction, including without 
	limitation the rights to use, copy, modify, merge, publish, distribute, sub
	license, and/or sell copies of the Software, and to permit persons  to whom 
	the Software is furnished to do so, subject to the following conditions:
	
	The above copyright notice and  this permission notice shall be included in 
	all copies or substantial portions of the Software.
	
	THE SOFTWARE IS PROVIDED "AS IS",  WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	IMPLIED, INCLUDING  BUT NOT  LIMITED  TO THE WARRANTIES OF MERCHANTABILITY,
	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	AUTHORS OR  COPYRIGHT  HOLDERS  BE  LIABLE  FOR ANY CLAIM, DAMAGES OR OTHER
	LIABILITY,  WHETHER  IN  AN  ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
	FROM,  OUT  OF  OR  IN  CONNECTION  WITH  THE  SOFTWARE OR THE USE OR OTHER 
	DEALINGS IN THE SOFTWARE.
 */
package com.ozazo.wave.robots.fw.engines;

import java.util.ArrayList;


/**
 * @author Araf Karsh Hamid
 *
 */
public interface BlipDataParserInterface {

	/**
	 * Parses the Blip text and returns Commands for further processing.
	 * For Example. From the following sentence marked with /w 
	 *  
	 * The /w "Battle of Stalingrad" was a major battle of World War II in which Nazi /w Germany and its 
	 * allies fought the Soviet Union for control of the city of Stalingrad (now Volgograd) in southwestern 
	 * /wd Russia.
	 * 
	 * The Commands Object will contain the following
	 * 
	 *  /w  "Battle of Stalingrad"
	 *  /w  Germany
	 *  /wd Russia
	 * 
	 * These Commands will be further processed by other engines to search the net for links, descriptions etc.
	 * Second argument is to check if the text needs to be processed in real time or not.
	 * 
	 * @param String blipText, boolean realTime
	 * @return List<Commands>
	 */

	public ArrayList<Commands> parse(String blipText, boolean realTime);	

	/**
	 * Parses the Blip text and returns Commands for further processing.
	 * For Example. From the following sentence marked with /w 
	 *  
	 * The /w "Battle of Stalingrad" was a major battle of World War II in which Nazi /w Germany and its 
	 * allies fought the Soviet Union for control of the city of Stalingrad (now Volgograd) in southwestern 
	 * /wd Russia.
	 * 
	 * The Commands Object will contain the following
	 * 
	 *  /w  "Battle of Stalingrad"
	 *  /w  Germany
	 *  /wd Russia
	 * 
	 * These Commands will be further processed by other engines to search the net for links, descriptions etc.
	 * With this method the text will be processed in NON Real Time mode (ie for Blip Submitted Mode).
	 * 
	 * @param String blipText, boolean realTime
	 * @return List<Commands>
	 */
	
	public ArrayList<Commands> parse(String blipText);	
}
